<?php
/**
 * Zend Framework
 *
 * LICENSE
 *
 * This source file is subject to the new BSD license that is bundled
 * with this package in the file LICENSE.txt.
 * It is also available through the world-wide-web at this URL:
 * http://framework.zend.com/license/new-bsd
 * If you did not receive a copy of the license and are unable to
 * obtain it through the world-wide-web, please send an email
 * to license@zend.com so we can send you a copy immediately.
 *
 * @category   Zend
 * @package    Zend_View
 * @subpackage Helper
 * @copyright  Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
 * @license    http://framework.zend.com/license/new-bsd     New BSD License
 * @version    $Id: FormElement.php 16541 2009-07-07 06:59:03Z bkarwin $
 */

/**
 * @see Zend_View_Helper_HtmlElement
 */
require_once 'Zend/View/Helper/HtmlElement.php';

/**
 * Base helper for form elements.  Extend this, don't use it on its own.
 *
 * @category   Zend
 * @package    Zend_View
 * @subpackage Helper
 * @copyright  Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
 * @license    http://framework.zend.com/license/new-bsd     New BSD License
 */
abstract class Zend_View_Helper_FormElement extends Zend_View_Helper_HtmlElement
{
	/**
	 * @var Zend_Translate
	 */
	protected $_translator;

	/**
	 * Get translator
	 *
	 * @return Zend_Translate
	 */
	public function getTranslator()
	{
		return $this->_translator;
	}

	/**
	 * Set translator
	 *
	 * @param  $translator|null Zend_Translate
	 * @return Zend_View_Helper_FormElement
	 */
	public function setTranslator($translator = null)
	{
		if (null === $translator) {
			$this->_translator = null;
		} elseif ($translator instanceof Zend_Translate_Adapter) {
			$this->_translator = $translator;
		} elseif ($translator instanceof Zend_Translate) {
			$this->_translator = $translator->getAdapter();
		} else {
			require_once 'Zend/Form/Exception.php';
			throw new Zend_Form_Exception('Invalid translator specified');
		}
		return $this;
	}

	/**
	 * Converts parameter arguments to an element info array.
	 *
	 * E.g, formExample($name, $value, $attribs, $options, $listsep) is
	 * the same thing as formExample(array('name' => ...)).
	 *
	 * Note that you cannot pass a 'disable' param; you need to pass
	 * it as an 'attribs' key.
	 *
	 * @access protected
	 *
	 * @return array An element info array with keys for name, value,
	 * attribs, options, listsep, disable, and escape.
	 */
	protected function _getInfo($name, $value = null, $attribs = null,
	$options = null, $listsep = null
	) {
		// the baseline info.  note that $name serves a dual purpose;
		// if an array, it's an element info array that will override
		// these baseline values.  as such, ignore it for the 'name'
		// if it's an array.
		$info = array(
            'name'    => is_array($name) ? '' : $name,
            'id'      => is_array($name) ? '' : $name,
            'value'   => $value,
            'attribs' => $attribs,
            'options' => $options,
            'listsep' => $listsep,
            'disable' => false,
            'escape'  => true,
		);

		// override with named args
		if (is_array($name)) {
			// only set keys that are already in info
			foreach ($info as $key => $val) {
				if (isset($name[$key])) {
					$info[$key] = $name[$key];
				}
			}
		}

		// force attribs to an array, per note from Orjan Persson.
		settype($info['attribs'], 'array');

		// Normalize readonly tag
		if (isset($info['attribs']['readonly'])
		&& $info['attribs']['readonly'] != 'readonly')
		{
			$info['attribs']['readonly'] = 'readonly';
		}

		// Disable attribute
		if (isset($info['attribs']['disable'])
		&& is_scalar($info['attribs']['disable']))
		{
			// disable the element
			$info['disable'] = (bool)$info['attribs']['disable'];
			unset($info['attribs']['disable']);
		} elseif (isset($info['attribs']['disable'])
		&& is_array($info['attribs']['disable']))
		{
			$info['disable'] = $info['attribs']['disable'];
			unset($info['attribs']['disable']);
		}

		// Set ID for element
		if (isset($info['attribs']['id'])) {
			$info['id'] = (string) $info['attribs']['id'];
		} elseif (!isset($info['attribs']['id']) && !empty($info['name'])) {
			$id = $info['name'];
			if (substr($id, -2) == '[]') {
				$id = substr($id, 0, strlen($id) - 2);
			}
			if (strstr($id, ']')) {
				$id = trim($id, ']');
				$id = str_replace('][', '-', $id);
				$id = str_replace('[', '-', $id);
			}
			$info['id'] = $id;
		}

		// Determine escaping from attributes
		if (isset($info['attribs']['escape'])) {
			$info['escape'] = (bool) $info['attribs']['escape'];
		}

		// Determine listsetp from attributes
		if (isset($info['attribs']['listsep'])) {
			$info['listsep'] = (string) $info['attribs']['listsep'];
		}

		// Remove attribs that might overwrite the other keys. We do this LAST
		// because we needed the other attribs values earlier.
		foreach ($info as $key => $val) {
			if (isset($info['attribs'][$key])) {
				unset($info['attribs'][$key]);
			}
		}

		// done!
		return $info;
	}

	/**
	 * Creates a hidden element.
	 *
	 * We have this as a common method because other elements often
	 * need hidden elements for their operation.
	 *
	 * @access protected
	 *
	 * @param $name The element name.
	 *
	 * @param $value The element value.
	 *
	 * @param $attribs Attributes for the element.
	 *
	 * @return string A hidden element.
	 */
	protected function _hidden($name, $value = null, $attribs = null)
	{
		return '<input type="hidden"'
		. ' name="' . $this->view->escape($name) . '"'
		. ' value="' . $this->view->escape($value) . '"'
		. $this->_htmlAttribs($attribs) . $this->getClosingBracket();
	}
}
